From 6bcc179281bd6cc548b147b213c3c8d2d77cc36e Mon Sep 17 00:00:00 2001 From: "emellor@leeni.uk.xensource.com" Date: Sun, 30 Oct 2005 17:19:35 +0100 Subject: [PATCH] Added doccomment. Signed-off-by: Ewan Mellor --- tools/python/xen/xend/server/DevController.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/tools/python/xen/xend/server/DevController.py b/tools/python/xen/xend/server/DevController.py index 8cbab6f9c2..fdc0404235 100644 --- a/tools/python/xen/xend/server/DevController.py +++ b/tools/python/xen/xend/server/DevController.py @@ -69,9 +69,15 @@ class DevController: def destroyDevice(self, devid): """Destroy the specified device. - The implementation here simply deletes the appropriate paths from - the store. This may be overridden by subclasses who need to perform - other tasks on destruction. + @param devid The device ID, or something device-specific from which + the device ID can be determined (such as a guest-side device name). + + The implementation here simply deletes the appropriate paths from the + store. This may be overridden by subclasses who need to perform other + tasks on destruction. Further, the implementation here can only + accept integer device IDs, or values that can be converted to + integers. Subclasses may accept other values and convert them to + integers before passing them here. """ devid = int(devid) -- 2.30.2